package com.likeycy.my.tree;

import java.util.Comparator;

/**
 * @ClassName: MyBinarySearchTree
 * @Description: 自定义二叉搜索树第一版
 * @Author: sodagreen
 * @Date: 2021/3/5 9:40
 * @Version: 1.0
 */
@SuppressWarnings("unchecked")
public class MyBinarySearchTree<E> extends BinaryTree<E> {

    /*
       二叉搜索树的特点是：也称为二叉查找树，二叉排序树
       1.节点与其他节点必须具有可比较性。比如节点存储的都是int、double。如果存储的是Object类型，那么需要指定哪些属性可以比较
       2.任意一个节点的值都大于其左子树所有节点的值。通俗来说就是从某一个父节点开始，其右边的节点都大于父节点，且大于左边不同同层级的节点值
       3.任意一个节点的值都小于其右子树所有节点的值。也就是从某一个父节点开始，左边的任意一个节点及其子节点，都小于右边同层级或不同层级的节点值
       4.它的左右子树也是一颗二叉树
       5. 二叉树是没有索引概念的
     */


    /**
     * 比较器
     */
    private final Comparator<E> comparator;

    public MyBinarySearchTree() {
        // 默认不传比较器
        this(null);
    }

    public MyBinarySearchTree(Comparator<E> comparator) {
        this.comparator = comparator;
    }

    /**
     * 向存储元素的容器尾部添加元素
     *
     * @param element
     */
    public void add(E element) {
        /*
            添加时需要解决的问题：
            1. 只实例化对象，还没有存储元素时，需要判断根节点是否Null，然后把元素添加到根节点
            2. 如果根节点不为Null，那么添加元素需要和根节点比较。左边存储的元素要小于父节点，右边则大于，根据这个规则判断
            3. 添加成功后需要进行size++
         */
        elementNotNullCheck(element);

        // 如果是第一次添加
        if (null == root) {
            root = newNode(element, null);
            size++;

            // 新添加节点之后调整二叉树的失衡状况
            afterAdd(root);
            return;
        }

        // 父节点也需要一个变量保存起来，因为 node == null 的时候，意味着找到父节点的子节点位置了。但是子节点位置没创建，parent也为空
        Node<E> parent = root;
        // 如果根节点不为空，表示不是第一次添加
        Node<E> node = root;
        // 这个条件需要存起来。因为查找到之后还需要根据它来判断是添加到父节点的左边还是右边
        int cmp = 0;
        // 由于需要不断的比较节点值，那么肯定需要循环比较。那么终止条件是什么呢？必然是node对象不等于null。
        do {
            // 首先从父节点开始比较
            cmp = compareTo(element, node.element);
            parent = node;
            // 判断值的范围大于父节点的值在分布在右边，小于父节点的值在左边
            if (cmp > 0) {
                node = node.right;
            } else if (cmp < 0) {
                node = node.left;
            } else {
                // 如果相等，应该考虑覆盖
                node.element = element;
                return;
            }
        } while (node != null);

        // 比较完成之后明确添加在父节点的左边还是右边
        Node<E> newNode = newNode(element, parent);
        if (cmp > 0) {
            parent.right = newNode;
        } else {
            parent.left = newNode;
        }
        size++;

        // 新添加节点之后调整二叉树的失衡状况
        afterAdd(newNode);
    }

    /**
     * 添加node节点之后调整二叉树的失衡状况
     * 该方法由继承的子类去实现
     * @param node 新添加的节点
     */
    protected void afterAdd(Node<E> node) { }

    /**
     * 删除node节点之后调整二叉树的失衡状况
     * 该方法由继承的子类去实现
     * @param node 被删除的节点 或者 用以取代被删除的节点的子节点(当被删除的节点是度为1时，即含有至少1个子节点)
     */
    protected void afterRemove(Node<E> node){}

    /**
     * 移除指定的元素
     *
     * @param element
     */
    public void remove(E element) {
        remove(getNodeByElement(element));
    }

    private void remove(Node<E> node) {
        if (node == null) {
            return;
        }
        size--;
        // 判断指定节点的左右子节点是否为空。true表示度为2的节点，有左右子节点
        if (node.left != null && node.right != null) {
            // 由于删除的节点下面有左右子节点，那么需要找到后继节点来替代指定要删除的节点
            Node<E> s = successor(node);
            // 用后继节点的值覆盖指定删除节点的值
            node.element = s.element;
            // 删除后继节点。这句很关键。
            node = s;
        }

        // 如果代码块执行到这里，表示删除的Node节点的度必然为1或0
        Node<E> replacement = (node.left != null ? node.left : node.right);
        // 表示度为1的节点
        if (replacement != null) {
            // 更改parent
            replacement.parent = node.parent;
            if (node.parent == null) {
                root = replacement;
            } else if (node == node.parent.left) {
                node.parent.left = replacement;
            } else if (node == node.parent.right) {
                node.parent.right = replacement;
            }

            // 来到这里表示节点已经被删除，删除之后的处理
            afterRemove(replacement);
        } else if (node.parent == null) {
            // 那表示拿到的node节点就是根节点
            root = null;

            // 来到这里表示节点已经被删除，删除之后的处理
            afterRemove(node);
        } else {
            if (node == node.parent.right) {
                node.parent.right = null;
            } else {
                node.parent.left = null;
            }

            // 来到这里表示节点已经被删除，删除之后的处理
            afterRemove(node);
        }
    }

    /**
     * 根据指定的元素返回找到的包含该元素的Node节点
     *
     * @param element 指定的元素值
     * @return 返回查找到的Node节点对象，返回null表示未找到
     */
    private Node<E> getNodeByElement(E element) {
        elementNotNullCheck(element);
        Node<E> node = root;
        while (node != null) {
            // 将传进来的元素值做比较，从根节点开始比较
            int cmp = compareTo(element, node.element);
            // 等于0,表示正好找到了
            if (cmp == 0) {
                return node;
            }
            // 大于0,表示在树的右边，因为二叉树就是右边的值大。如果小于0，那就在左边找
            if (cmp > 0) {
                node = node.right;
            } else {
                node = node.left;
            }
        }
        // 退出循环了表示没有找到，那就返回null
        return null;
    }

    /**
     * 检查指定的元素是否包含在容器中。
     *
     * @param element
     * @return
     */
    public boolean contains(E element) {
        return getNodeByElement(element) != null;
    }

    /**
     * 比较两个值的大小
     *
     * @param e1 指定的元素
     * @param e2 当前要比较的节点元素
     * @return 返回值等于0，代表 e1 == e2；返回值大于0，代表 e1 大于 e2；返回值小于0，代表 e1 小于 e2
     */
    private int compareTo(E e1, E e2) {
        // 传入比较器则通过比较器比较
         if (comparator != null) {
            return comparator.compare(e1, e2);
        }
        // 没传比较器，元素内部必须自行实现了 Comparable 接口
        return ((Comparable<E>) e1).compareTo(e2);
    }

    /**
     * 检测参数是否为空
     * 由于二叉树中不允许存储为Null的元素，因为Null无法和其它元素比较，所以检测是必须的
     *
     * @param element 指定的检测元素
     */
    private void elementNotNullCheck(E element) {
        if (null == element) {
            throw new IllegalArgumentException("element must not be null(参数不能为空！)");
        }
    }
}
